home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / BROWSERS / IRC_061 / ATARIRC.DOC < prev    next >
Encoding:
Text File  |  1996-08-28  |  12.9 KB  |  336 lines
  1. AtarIRC Documentation
  2. ---------------------
  3. Recoded by Lonny L Pursell
  4. (C)1996 by Lonny L Pursell and ENCOM
  5. All rights reserved.
  6.  
  7. ** FreeWare **
  8.  
  9.  
  10. Disclaimer
  11. ----------
  12. Use entirely at your own risk!
  13.  
  14.  
  15. Support
  16. -------
  17. This program is FreeWare.  This program is fully functional and
  18. there are no disabled features or keys required to use it.  You
  19. need not send me anything, however any donations will be accepted.
  20.  
  21. Contact:
  22.  
  23. Lonny Pursell
  24. 101 1/2 S High Street  Apt C
  25. Columbus Grove  OH  45830
  26. USA
  27.  
  28. E-Mail: lpursell@bright.net
  29.    WWW: http://www.bright.net/~lpursell/
  30.    IRC: lp on channel #Atari
  31.  
  32. When reporting bugs please include the version number and a
  33. _detailed_ description of your system setup.
  34.  
  35. Note: I do not have the time or desire to blindly track what
  36. looks like bugs on non-Atari hardware.  If this program fails
  37. on an emulator I suggest you either don't use this program or
  38. get a real computer.
  39.  
  40.  
  41. Credits
  42. -------
  43. IRC_QR.DOC was made by Glen Kelly (aka GeeCK) for PageStream.
  44. IRC_QR.HYP was made by Nicholas Flintham (aka Flinny) for ST-Guide.
  45. IRCPRIMR.TXT (A short IRC primer) Written by Nicolas Pioch (Nap on IRC)
  46.                    
  47.  
  48. IRC Client Information
  49. ----------------------
  50. A channel on IRC is referenced with the '#' in front of it.  The
  51. Atari channel would be refered to as '#Atari' in all related IRC
  52. commands.
  53.  
  54. Anything entered into the IRC client starting with a '/' is
  55. interpreted as a command, otherwise it's echoed to the current
  56. channel for all to see.
  57.  
  58. All commands not listed below are sent to the server just as you
  59. typed them.  The IRC client doesn't interpret them at all so any
  60. error messages you see are server generated.
  61.  
  62.  
  63. Command List
  64. ------------
  65. /AWAY
  66.   '/away' marks you as being away and displays the default message
  67.   '/away message' marks you as being away and displays 'message' 
  68.   when on an '*' appears next to the timer
  69.   the current channel is notified that you are marked as away
  70. /BYE
  71.   same as /quit
  72. /BACK
  73.   '/back' turns away off and uses the default message
  74.   '/back message' turns away off and uses 'message'
  75.   the current channel is notified when you return
  76. /BAN
  77.   '/ban' shows a list of bans for the current channel
  78.   '/ban mask' will set a ban for 'mask' on the current channel
  79. /CAPTURE
  80.   '/capture' display capture file size in bytes
  81.   '/capture on' turns capture on
  82.   '/capture off' turns capture off
  83.   when on a 'C' will appear next to the timer in the status bar
  84.   all text shown in the scrolling area will be captured
  85.   when the limit is reached a bell sounds and capture is turned off
  86. /CD
  87.   '/cd' displays the current path
  88.   '/cd path' sets the 'path' on the current drive
  89.   '/cd \' sets the path to the root of the current drive
  90.   '/cd ..' backs up one folder on the current drive
  91. /CHDRIVE
  92.   '/chdrive' displays the current drives
  93.   '/chdrive d' set the current drive to 'd'
  94. /CLIENTINFO
  95.   '/clientinfo' request clinetinfo from everyone in the current channel
  96.   '/clientinfo nick' sends a clientinfo request to 'nick'
  97.   '/clientinfo #channel' request clientinfo from everyone in '#channel'
  98. /COLOR
  99.   '/color' displays the color menu options and current color settings
  100.   '/color i c' sets item 'i' to color 'c'
  101.   example: '/color A 3' will change the background color to color 3
  102. /COLOUR
  103.   same as /color
  104. /CONFIG
  105.   '/config' edit the configuration (must be off-line)
  106.   '/config save' will save all config data to disk
  107.   '/config load' will load all config data from disk
  108. /CONNECT
  109.   '/connect' attempt connection to default server and port
  110.   '/connect i' attempt connection to 'i' from the server list
  111.   '/conncet server' attempt connection to 'server' on default port
  112.   '/conncet server port' attempt connection to 'server' on 'port'
  113. /CTCP nick message
  114.   '/ctcp nick' defaults to '/ctcp nick version'
  115.   '/ctcp nick message' sends a ctcp 'message' to 'nick'
  116.   the 'message' will be converted to uppercase
  117.   ctcp returns 'errmsg' in reply to unsupported ctcp commands
  118. /DCC
  119.   '/dcc' same as '/dcc list'
  120.   '/dcc list' shows status of current dcc connections and channels
  121.   '/dcc chat nick' starts a private chat session with 'nick'
  122.   '/dcc send nick' send 'nick' a file via the file selector
  123.   '/dcc send nick file' send 'nick' a 'file'
  124.   if the remote end doesn't send the file size it displays '-1' instead
  125. /DEBUG
  126.   '/debug' shows conenction data which is all in $hex
  127.   '/debug on' begins data logging
  128.   '/debug off' stops data logging
  129.   '/debug mem' show free memory status
  130.   '/degub misc' show some internal values
  131.   '/debug history' show command line history
  132.   the log file will conatain all data going in and out of the irc client
  133.   holding the alternate key when the program starts begins logging too
  134.   a check mark appears in the window info line when debug mode is on
  135. /DEFINE
  136.   '/define' displays the current contents of all ~variables
  137.   '/define string' is used to define the variable ~user only
  138.   example: '/define lp' would set variable ~user to 'lp'
  139. /DELETE
  140.   '/delete file' deletes 'file' from disk
  141.   the file will be deleted when you press return with no warning
  142. /DEOP
  143.   '/deop nick' will take operator status away from 'nick' if you are an op
  144.   more than one nick can be listed seperated by spaces
  145. /DFREE
  146.   '/dfree' returns the free bytes on the current drive
  147.   '/dfree d' returns the free bytes on drive 'd'
  148. /DIR
  149.   '/dir' lists all files in the current drive path '*.*'
  150.   '/dir mask' lists all files in the current drive path matching 'mask'
  151.   files show sizes and and folders show '<dir>' instead
  152.   press escape to abort the dir
  153. /DISCONNECT
  154.   '/disconnect' disconnects you from the server only (default quit message)
  155.   '/disconnect message' disconnects you from the server with 'message'
  156.   all dcc connections remain intact and active
  157. /ECHO
  158.   '/echo nick message' requests an echo from 'nick'
  159.   '/echo #channel message' requests an echo from everyone in '#channel'
  160. /EXIT
  161.   same as /quit
  162. /FIND
  163.   '/find data' will search the user list for 'data'
  164.   this command translates to '/who *data*'
  165. /FINGER
  166.   '/finger' fingers everyone in the current channel
  167.   '/finger nick' sends a finger request to 'nick'
  168.   '/finger #channel' sends a finger request to everyone in '#channel'
  169. /FKEY
  170.   '/fkey' will also display function key settings
  171.   '/fkey n' will display the current setting of function key 'n'
  172.   '/fkey n string' will set function key 'n' to 'string'
  173.   20 fkeys can be setup: f1-f10 alone and f1-f10 with shift
  174.   function keys are limited to a maximum of 400 chars when fully expanded
  175.   fkey strings can contain dynamic variables using ~varname
  176.     ~nick     your current nick
  177.     ~chan     current channel (same as prompt)
  178.     ~join     last nick that entered the current channel
  179.     ~part     last nick that left the current channel
  180.     ~ping     last nick that did a /ping on you
  181.     ~finger   last nick that did a /finger on you
  182.     ~version  last nick that did a /version on you
  183.     ~msg      last nick that sent you a private /msg or you did /msg too 
  184.     ~quit     last nick that quit irc from current channel
  185.     ~kick     last nick that was kicked from the current channel
  186.     ~ctcp     last nick that sent you a /ctcp message or you did /ctcp too
  187.     ~date     current date format: mm/dd/yyy
  188.     ~time     current time format: hh:mm:ss (24 hour clock)
  189.     ~ctime    connect time format: 00h00m00s
  190.     ~invite   last nick that sent you an invite message
  191.     ~user     user definable string
  192.     ~rnick    generates a random 9 character string to be used as a nick
  193.     ~cnick    last nick changed on any channel you might be in
  194.     ~|        return (only one per fkey and must be on the end if used)
  195.   example: /fkey 1 my nick is ~nick and i am in channel ~chan~|
  196.     pressing f1 would display: 'my nick is lp and i am in channel #atari' 
  197. /INVITE
  198.   '/invite nick' will invite 'nick' to current the channel
  199. /JOIN 
  200.   '/join' joins the default channel
  201.   '/join #channel' join IRC '#channel'
  202. /KICK
  203.   '/kick nick' remove 'nick' from current channel and display default message
  204.   '/kick nick message' remove 'nick' from current channel and display 'message'
  205. /KICKBAN
  206.   '/kickban nick' kicks and and bans 'nick' with a simple nick mask
  207.      default kick message is used
  208.   '/kickban nick mask' kicks and bans nick with specific 'mask'
  209.      default kick message is used
  210.   '/kickban nick mask message' kicks and bans 'nick' with 'mask'
  211.      'message' will be used instead of default kick message
  212. /LEAVE
  213.   same as /part
  214. /LOGOFF
  215.   same as /disconnect
  216. /LOGON
  217.   same as /connect
  218. /ME
  219.   '/me message' displays your nick followed by 'messege'
  220.   example: '/me loves Atari' displays 'lp loves Atari'
  221. /MKDIR
  222.   '/mkdir folder' creates folder 'folder' on the current drive
  223. /MSG nick message 
  224.   '/msg nick message'  sends 'nick' a private 'message'
  225.   example: '/msg lp Are we having fun yet?'
  226. /NICK nick
  227.   '/nick newnick' changes your nick to 'newnick'
  228.   a nick has a maximum of 9 characters
  229. /OP
  230.   '/op nick' will give 'nick' operator status if you are an op
  231.   more than one nick can be listed seperated by spaces
  232. /PART
  233.   '/part' leave current channel
  234.   leave current channel
  235. /PING
  236.   '/ping' ping everyone in the current channel
  237.   '/ping nick' ping 'nick' only
  238.   '/ping #channel' ping everyone in '#channel'
  239. /PRINT
  240.   '/print file.txt' sends file 'file.txt' to the line printer
  241.   press escape to abort the printing
  242. /QUIT
  243.   'quit' leave IRC and display default message (closes the IRC session)
  244.   '/quit message' leave IRC and display 'message'
  245.   example: '/QUIT I'll be back...'
  246.   ends all dcc connections that might still be active
  247.   exits the program
  248. /RENAME
  249.   'rename file1 file2' renames 'file1' to 'file2'
  250.   the file will be renamed when you press return with no warning
  251. /RMDIR
  252.   '/rmdir folder' deletes folder 'folder' on the current drive
  253.   only empty folders can be deleted
  254. /SEARCH
  255.   '/search' same as doing '/list' so be prepared to for a long list
  256.   '/search string' does a '/list' but only displays matches to 'string'
  257. /SEND
  258.   '/send file.txt' sends 'file.txt' to the current window
  259.   the data is sent out the modem and eched to the screen too
  260.   press escape to abort the send
  261. /SERVER
  262.   same as /connect
  263. /SOUND
  264.   '/sound nick file' sends a sound command to 'nick' to play sound 'file'
  265.   '/sound nick' sends 'default.wav'
  266.   if the '.wav' extender is missing it's added
  267. /TIME
  268.   '/time' returns the server time information
  269.   '/time nick' requests time information from 'nick'
  270.   '/time #channel' requests time information from eveyone in '#channel'
  271. /TOPIC
  272.   '/topic' displays the current channel topic
  273.   '/topic string' sets current channel topic to 'string'
  274. /UNBAN
  275.   '/unban mask' will remove the ban for 'mask' on the current channel
  276. /USERINFO
  277.   '/userinfo' request userinfo from everyone in the current channel
  278.   '/userinfo nick' sends a userinfo request to 'nick'
  279.   '/userinfo #channel' request userinfo from everyone in '#channel'
  280. /VERSION
  281.   '/version' returns the server version information
  282.   '/version nick' requests version information from 'nick'
  283.   '/version #channel' requests version information from eveyone in '#channel'
  284. /VIEW
  285.   '/view file' displays 'file' to the screen only
  286.   no data is sent out the modem
  287.   press escape to abort the view
  288.  
  289.  
  290. Misc Keys 
  291. ---------
  292. ALTERNATE    pause screen
  293.   this might help with viewing the channel /list
  294.   holding the alternate key down too long may cause data overflow?
  295. BACKSPACE    edit command line
  296. CLR HOME     clear screen
  297. CONTROL B    toggle bold text on and off
  298. CONTROL C    close a dcc chat or file session
  299. CONTROL D    toggles the /msg bell on and off
  300.   when the /msg bell is on the letter 'B' appears next to the timer
  301. CONTROL F    flood control (enable/disables incoming ctcp and msg commands)
  302.   when flood control is on the letter 'F' appears next to the timer
  303. CONTROL K    tcp kick current send window 
  304. CONTROL P    ping server
  305. CONTROL S    toggle color/mono background redrawing
  306. CONTROL U    restore default colors (black text on a white background)
  307. CONTROL V    toggle reverse text on and off
  308. CONTROL -    toggle underline text on and off
  309. DELETE       same as backspace
  310. DOWN ARROW   scroll command line history down
  311. ESCAPE       clear the command line/interrupt modem activity
  312. F1-F10       function key macro
  313. HELP         show server settings
  314. INSERT       last command recall
  315.   this only works on a blank command like
  316. LEFT ARROW   change window down one
  317. RETURN       execute command line
  318. RIGHT ARROW  change window up one
  319. SHIFT F1-F10 function key macro
  320. TAB          auto /msg reply, this types '/msg nick' for you
  321. UNDO         show function key settings
  322. UP ARROW     scroll command line history up
  323.  
  324.  
  325. Known Problems
  326. --------------
  327. For some reason certain key combinations are interpreted as
  328. though function key f13 was pressed when it was not.  To work
  329. around this minor bug do not define f13 as anything.
  330.  
  331. The identd feature seems to not function for some people.  The
  332. fix for now is to shut it off.
  333.  
  334.  
  335. eof
  336.